/*
 * Copyright (c) 2013, 2024, Oracle and/or its affiliates. All rights reserved.
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * This code is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License version 2 only, as
 * published by the Free Software Foundation.  Oracle designates this
 * particular file as subject to the "Classpath" exception as provided
 * by Oracle in the LICENSE file that accompanied this code.
 *
 * This code is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
 * version 2 for more details (a copy is included in the LICENSE file that
 * accompanied this code).
 *
 * You should have received a copy of the GNU General Public License version
 * 2 along with this work; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 *
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
 * or visit www.oracle.com if you need additional information or have any
 * questions.
 */
package jdk.graal.compiler.graphio.parsing.model;

public interface FolderElement {

    Folder getParent();

    String getName();

    void setParent(Folder parent);

    default GraphDocument getOwner() {
        Folder f = getParent();
        while (f != null) {
            if (f instanceof GraphDocument) {
                return (GraphDocument) f;
            }
            f = f.getParent();
        }
        return null;
    }

    /**
     * Opaque ID which identifies the element. This ID must be the same even though the referenced
     * object is re-created from the dumped data gain. The returned object must consistently define
     * {@link Object#hashCode} and {@link Object#equals} to allow identity comparison
     */
    Object getID();
}
